home *** CD-ROM | disk | FTP | other *** search
/ PC World 2007 June / PCWorld_2007-06_cd.bin / temacd / wikipad / WikidPad-1.9beta2.exe / {app} / WikidPadHelp / data / CommandLineSupport.wiki < prev    next >
Encoding:
Text File  |  2006-02-24  |  2.4 KB  |  85 lines
  1. ∩╗┐++ Command Line Support
  2.  
  3. +++ Old form
  4.  
  5. You can have up to two command line parameters, without leading '-'
  6. which have the following meaning:
  7.  
  8. *First parameter* can be a path to a .wiki file (either a text file with
  9. wiki page content (this page is opened then) or the wiki configuration
  10. file). Instead of a path it can also be an URL with wiki: protocol
  11.  
  12. *Second parameter* can be the name of a wiki word to open, if not
  13. specified in the first parameter.
  14.  
  15.  
  16. +++ New form
  17.  
  18. You can specify switches and/or parameters on the command line where
  19. the names of the switches either consist of a '-' and a character
  20. (short form, e.g. "-h") or begin with two dashes and a name (long
  21. form, e.g. "--help").
  22.  
  23. Some switches also take a parameter which must follow the switch on
  24. the command line.
  25.  
  26. The following list of switches shows the short form (not present for
  27. all options), the long form and (if necessary) the meaning of the
  28. parameter in angle brackets:
  29.  
  30.  
  31. ++++ General
  32.  
  33. *-h, --help*
  34. Shows a message box with a short overview of available switches.
  35.  
  36. *-w, --wiki  <wiki path>*
  37. Set the wiki to open on startup (same as first parameter of old form).
  38.  
  39. *-p, --page <page name>*
  40. Set the page to open on startup (same as second parameter of old form).
  41.  
  42. *-x, --exit*
  43. Exit immediately after command line actions were completed.
  44.  
  45.  
  46. ++++ Exporting
  47.  
  48. The following three must all be specified if you want to export
  49. something, the fourth (--export-compfn) is optional:
  50.  
  51. *--export-what <what>*
  52. Choose if you want to export *page*, *subtree* or *wiki*.
  53.  
  54. *--export-type <type>*
  55. Tag of the export type. Currently this can be:
  56.  
  57.     * html_single: Single HTML page
  58.     * html_multi: Set of HTML pages
  59.     * xml: XML output
  60.     * raw_files: Set of \*.wiki files in UTF-8 format with BOM
  61.  
  62. *--export-dest <destination path>*
  63. Path of destination directory for export.
  64.  
  65.  
  66. *--export-compfn*
  67. Use compatible filenames on export.
  68.  
  69.  
  70. ++++ Special
  71.  
  72. *--deleteconfig*
  73. If this is the only switch on the command line, the program deletes
  74. (*without further request!*) the configuration files which are the
  75. main "WikidPad.config" file as well as everything in
  76. ".WikidPadGlobals" directory (normally only the global text blocks
  77. file).
  78.  
  79. After that the program terminates immediately (otherwise the files
  80. would be recreated).
  81.  
  82. This switch is mainly used for the uninstalling of a Windows binary.
  83. The uninstaller *will* ask before running WikidPad with this option.
  84.  
  85.